bug 22297 - "syntax for substitution that doesn't break transclusion"

Adds "safesubst:$1" that works similarly to "subst:$1"
(relevant to bug 5453, bug 16714, bug 4484)

diff --git a/RELEASE-NOTES b/RELEASE-NOTES
index a43fe15..a277960 100644 (file)
--- a/RELEASE-NOTES
+++ b/RELEASE-NOTES
@@ -809,6 +809,7 @@ it from source control: http://www.mediawiki.org/wiki/Download_from_SVN
 * (bug 22248) Output extension URLs in meta=siteinfo&siprop=extensions
 * Support key-params arrays in 'descriptionmsg' in meta=siteinfo&siprop=extensions
 * (bug 21922) YAML output should quote asterisk when used as key
+* (bug 22297) safesubst: to allow substitution without breaking transclusion
 
 === Languages updated in 1.16 ===
 

diff --git a/includes/MagicWord.php b/includes/MagicWord.php
index 632395d..0913e6d 100644 (file)
--- a/includes/MagicWord.php
+++ b/includes/MagicWord.php
@@ -165,6 +165,10 @@ class MagicWord {
                'nocontentconvert',
        );
 
+       static public $mSubstIDs = array(
+               'subst',
+               'safesubst',
+       );
 
        static public $mObjects = array();
        static public $mDoubleUnderscoreArray = null;
@@ -216,6 +220,13 @@ class MagicWord {
                return self::$mVariableIDs;
        }
 
+       /**
+        * Get an array of parser substitution modifier IDs
+        */
+       static function getSubstIDs() {
+               return self::$mSubstIDs; 
+       }
+
        /* Allow external reads of TTL array */
        static function getCacheTTL($id) {
                if (array_key_exists($id,self::$mCacheTTLs)) {

diff --git a/includes/parser/Parser.php b/includes/parser/Parser.php
index cd101f7..3b24615 100644 (file)
--- a/includes/parser/Parser.php
+++ b/includes/parser/Parser.php
@@ -91,9 +91,9 @@ class Parser
         */
        # Persistent:
        var $mTagHooks, $mTransparentTagHooks, $mFunctionHooks, $mFunctionSynonyms, $mVariables,
-               $mImageParams, $mImageParamsMagicArray, $mStripList, $mMarkerIndex, $mPreprocessor,
-               $mExtLinkBracketedRegex, $mUrlProtocols, $mDefaultStripList, $mVarCache, $mConf,
-               $mFunctionTagHooks;
+               $mSubsts, $mImageParams, $mImageParamsMagicArray, $mStripList, $mMarkerIndex,
+               $mPreprocessor, $mExtLinkBracketedRegex, $mUrlProtocols, $mDefaultStripList,
+               $mVarCache, $mConf, $mFunctionTagHooks;
 
 
        # Cleared with clearState():
@@ -2617,15 +2617,17 @@ class Parser
        }
 
        /**
-        * initialise the magic variables (like CURRENTMONTHNAME)
+        * initialise the magic variables (like CURRENTMONTHNAME) and substitution modifiers 
         *
         * @private
         */
        function initialiseVariables() {
                wfProfileIn( __METHOD__ );
                $variableIDs = MagicWord::getVariableIDs();
+               $substIDs = MagicWord::getSubstIDs();
 
                $this->mVariables = new MagicWordArray( $variableIDs );
+               $this->mSubsts = new MagicWordArray( $substIDs );
                wfProfileOut( __METHOD__ );
        }
 
@@ -2796,12 +2798,19 @@ class Parser
                # SUBST
                wfProfileIn( __METHOD__.'-modifiers' );
                if ( !$found ) {
-                       $mwSubst = MagicWord::get( 'subst' );
-                       if ( $mwSubst->matchStartAndRemove( $part1 ) xor $this->ot['wiki'] ) {
-                               # One of two possibilities is true:
-                               # 1) Found SUBST but not in the PST phase
-                               # 2) Didn't find SUBST and in the PST phase
-                               # In either case, return without further processing
+
+                       $substMatch = $this->mSubsts->matchVariableStartToEnd( $part1 );
+
+                       # Possibilities for substMatch[0]: "subst", "safesubst" or FALSE
+                       # Whether to include depends also on whether we are in the pre-save-transform
+                       #
+                       # safesubst || (subst && PST) => transclude (handled by if)
+                       # (false && PST) || (subst && !PST)  => return input (handled by else if)
+                       # false && !PST => transclude (no handling needed here)
+                       if ( $substMatch[0] && ( $this->ot['wiki'] || $substMatch[0] == 'safesubst' ) ) {
+                               $part1 = $substMatch[1];
+
+                       } else if ( $substMatch[0] xor $this->ot['wiki'] ) {
                                $text = $frame->virtualBracketedImplode( '{{', '|', '}}', $titleWithSpaces, $args );
                                $isLocalObj = true;
                                $found = true;

diff --git a/languages/messages/MessagesEn.php b/languages/messages/MessagesEn.php
index 9c6d478..d588b04 100644 (file)
--- a/languages/messages/MessagesEn.php
+++ b/languages/messages/MessagesEn.php
@@ -264,7 +264,8 @@ $magicWords = array(
        'subjectpagename'        => array( 1,    'SUBJECTPAGENAME', 'ARTICLEPAGENAME' ),
        'subjectpagenamee'       => array( 1,    'SUBJECTPAGENAMEE', 'ARTICLEPAGENAMEE' ),
        'msg'                    => array( 0,    'MSG:'                   ),
-       'subst'                  => array( 0,    'SUBST:'                 ),
+       'subst'                  => array( 0,    'SUBST:$1'               ),
+       'safesubst'              => array( 0,    'SAFESUBST:$1'           ),
        'msgnw'                  => array( 0,    'MSGNW:'                 ),
        'img_thumbnail'          => array( 1,    'thumbnail', 'thumb'     ),
        'img_manualthumb'        => array( 1,    'thumbnail=$1', 'thumb=$1'),